package cn.com.w.boot_swagger.config;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * 通过createRestApi函数创建Docket的Bean之后，
 * apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。
 * select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现，
 * 本例采用指定扫描的包路径来定义，Swagger会扫描该包下所有Controller定义的API，
 * 并产生文档内容（除了被@ApiIgnore指定的请求）。
 */
@Configuration
@EnableSwagger2 //开启swagger2
public class SwaggerConfig {

    @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2)
                // 分组名
                .groupName("A");
    }

    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2)
                // 分组名
                .groupName("B");
    }

    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2)
                // 分组名
                .groupName("C");
    }

    /**
     * 配置Swagger2的bean实例Docket
     * @return
     */
    @Bean
    public Docket createRestApi(Environment environment) {

        // 设置要显示的Swagger环境
        Profiles profiles = Profiles.of("dev", "test", "mysql");
        // 通过environment.acceptsProfiles(profiles)判断是否处在自己设定的环境。
        boolean flag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //是否启动swagger
                .enable(flag)
                // 分组名
                .groupName("l-pet-team")
                .select()
                //basePackage-包扫描方式
                //any-扫描全部
                //none-全不扫描
                //withClassAnnotation-类上注解扫描方式
                //withMethodAnnotation-扫描方法上的注解
                //.apis(RequestHandlerSelectors.basePackage("cn.com.w.boot_swagger"))
                .apis(RequestHandlerSelectors.any())
                //paths-过滤
                .paths(PathSelectors.ant("/**"))
                .build();
    }

    /**
     * 构建 swagger2的api文档的详细信息函数
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("Spring Boot 使用 Swagger2 构建接口文档。")
                //描述
                .description("API 描述：简单优雅的RESTful API")
                //作者信息
                .contact(new Contact("zxl", "http://localhost:8080", "zhangxl1016@163.com"))
                //版本号
                .version("1.0")
                //  服务条款地址
                .termsOfServiceUrl("http://localhost:80")
                .build();
    }


}
